bug: type top_p as float in Completion.create#436
Open
anxkhn wants to merge 1 commit into
Open
Conversation
anxkhn
commented
Jul 10, 2026
Completion.create and AsyncCompletion.create annotated top_p as Union[bool, NotGiven], but top_p is a nucleus-sampling probability (a float). Every other top_p in the SDK and the underlying OpenAI completions parameter is a float, and the sibling sampling params (temperature, frequency_penalty, presence_penalty) in the same two signatures are already Union[float, NotGiven]. The bool annotation made a valid call such as completions.create(..., top_p=0.9) fail type checkers and led IDEs to suggest True/False for a probability field. Change the annotation to Union[float, NotGiven] at both sites. Annotation-only; no runtime behavior changes. Add an offline regression test asserting the top_p annotation includes float (and not bool) for both the sync and async create signatures. Signed-off-by: Anas Khan <83116240+anxkhn@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.